Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## rdlc.rdl
Class Message_Event

    java.lang.Object
      rdlc.rdl.Declaration_Named
          rdlc.rdl.Message_Event

All Implemented Interfaces:
  Declaration, Expression, Message

     class Message_Event

extends Declaration_Named
implements Message

Standard event message type. Carries no data, and has a zero bitwidth.

Version:
  $Revision: 1.3 $
Author:
  Greg Gibeling

Nested Class Summary

Nested classes/interfaces inherited from interface rdlc.rdl.Expression
`Expression.Phase`

Field Summary

Fields inherited from class rdlc.rdl.Declaration_Named
`iName, namespace, rawStaticID`

Constructor Summary
`Message_Event()` Full constructor for an event message.

Method Summary
`Catalog<java.lang.String,Message>` | `getFields()` Simple accessor.
`java.lang.String` | `getLambdaName()` Simple accessor.
`java.util.Hashtable<java.lang.String,java.lang.Integer>` | `getName2Tag()` Simple accessor.
`java.util.Hashtable<java.lang.Integer,java.lang.String>` | `getTag2Name()` Simple accessor.
`int` | `getTagWidth()` Simple accessor.
`int` | `getWidth()` Simple accessor.
`boolean` | `isVariableWidth()` Simple accessor.
`java.lang.String` | `toString()` Simple accessor.
`boolean` | `typeMatch(Expression e)` Will only match against another event messages.

Methods inherited from class rdlc.rdl.Declaration_Named
`getBase, getIdentifier, getNamedBase, getRawStaticID, getRequirements, getType, resolve, setNamespace, setRawStaticID`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface rdlc.rdl.Declaration
`getBase, getIdentifier, getNamedBase, getType, setRawStaticID`

Methods inherited from interface rdlc.rdl.Expression
`getRequirements, resolve, setNamespace`

Constructor Detail

### Message_Event

    public Message_Event()

  Full constructor for an event message.

Method Detail

### toString

    public java.lang.String toString()

  Simple accessor.

  Overrides:
    `toString` in class `Declaration_Named`
  Returns:
    A human readable representation of this map for debugging.

### getWidth

    public int getWidth()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `getWidth` in interface `Message`
  Returns:
    `0` since event messages are have no data.
  See Also:
    `Message.getWidth()`

### getTagWidth

    public int getTagWidth()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `getTagWidth` in interface `Message`
  Returns:
    `0` since event messages are untagged.
  See Also:
    `Message.getTagWidth()`

### getName2Tag

    public java.util.Hashtable<java.lang.String,java.lang.Integer> getName2Tag()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `getName2Tag` in interface `Message`
  Returns:
    `null` since event messages have no fields.
  See Also:
    `Message.getName2Tag()`

### getTag2Name

    public java.util.Hashtable<java.lang.Integer,java.lang.String> getTag2Name()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `getTag2Name` in interface `Message`
  Returns:
    `null` since event messages have no fields.
  See Also:
    `Message.getTag2Name()`

### getFields

    public Catalog<java.lang.String,Message> getFields()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `getFields` in interface `Message`
  Returns:
    `null` since event messages have no fields.
  See Also:
    `Message.getFields()`

### isVariableWidth

    public boolean isVariableWidth()

  Description copied from interface: `Message`
  Simple accessor.

  Specified by:
    `isVariableWidth` in interface `Message`
  Returns:
    `false` since a event message has a fixed bitwidth.
  See Also:
    `Message.isVariableWidth()`

### typeMatch

    public boolean typeMatch(Expression e)

  Will only match against another event messages. This should only be called when unnamed messages are used directly in unit ports, structs or unions since RDL has a named type system.

  Specified by:
    `typeMatch` in interface `Expression`
  Parameters:
    `e` - The expression to check this one against.
  Returns:
    `true` if these two expressions match in type.
  See Also:
    `Expression.typeMatch(Expression)`

### getLambdaName

    public java.lang.String getLambdaName()

  Description copied from interface: `Declaration`
  Simple accessor.

  Specified by:
    `getLambdaName` in interface `Declaration`
  Returns:
    A simple and boring type name.
  See Also:
    `Declaration.getLambdaName()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD